Flask 是一個輕量級的 Python 網頁應用程式框架,它非常適合用於快速開發 RESTful API。本教學將引導你進入 Flask 的世界,從頭開始建立一個簡單的 RESTful API。
步驟 1:安裝 Flask
首先,確保你已經安裝了 Python。然後,你可以使用 pip 安裝 Flask:
pip install Flask
步驟 2:建立 Flask 應用程式
在你的專案目錄中,創建一個新的 Python 檔案,例如 app.py。這個檔案將包含你的 Flask 應用程式。
app.py
from flask import Flask
app = Flask(name)
@app.route('/')
def hello_world():
return 'Hello, World!'
在這個例子中,我們建立了一個 Flask 應用程式,定義了一個根路由 /,並設定了一個簡單的回應。
步驟 3:運行 Flask 應用程式
現在,你可以運行你的 Flask 應用程式。在專案目錄中,執行以下命令:
export FLASK_APP=app
export FLASK_ENV=development
flask run
這會啟動 Flask 應用程式並告訴你在哪個 URL 可以訪問它(通常是 http://localhost:5000)。
步驟 4:測試你的 API
打開你的瀏覽器或 API 測試工具,並訪問你的 API 端點。在我們的例子中,你可以在瀏覽器中輸入 http://localhost:5000,你應該會看到 "Hello, World!" 的回應。
步驟 5:建立更多的路由
你可以繼續建立更多的路由,以構建你的 RESTful API。例如,你可以建立一個路由來處理用戶的資訊或存取資料庫。這是一個簡單的例子:
app.py
@app.route('/user/int:user_id')
def get_user(user_id):
# 在這裡查詢用戶資訊並返回 JSON 格式的回應
user = {'id': user_id, 'name': 'John'}
return jsonify(user)
在這個例子中,我們建立了一個接受用戶 ID 的路由,查詢用戶資訊並返回 JSON 格式的回應。